/*
 * Copyright 2013-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cloud.gateway.handler.predicate;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Predicate;
import java.util.regex.Pattern;

import jakarta.validation.constraints.NotEmpty;

import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;

/**
 * @author Spencer Gibb
 * <p>
 *     HeaderRoutePredicateFactory 是 Spring Cloud Gateway 中的一个具体实现类，用于定义 基于 HTTP Header 的路由谓词。它的作用是根据请求中特定名称的 Header 是否存在以及其值是否匹配指定的正则表达式来决定是否匹配该路由。
 *     以下是对其功能、设计和使用场景的详细解析。
 *1. 核心功能
 * 1.1 路由匹配逻辑
 * HeaderRoutePredicateFactory 的核心逻辑是：
 * 检查请求中的 Header 是否存在指定名称的 Header。
 * 如果存在，则进一步检查其值是否匹配指定的正则表达式（如果提供了正则表达式）。
 * 如果满足条件，则返回 true，表示请求匹配该路由；否则返回 false。
 * 1.2 配置支持
 * 它继承了 AbstractRoutePredicateFactory，并实现了快捷配置支持。
 * 通过 shortcutFieldOrder 方法定义了快捷配置的字段顺序，允许用户以简化的形式定义参数。
 * 1.3 自定义谓词
 * 它返回一个自定义的 GatewayPredicate 实现，包含以下内容：
 * 匹配逻辑（test 方法）。
 * 配置对象（getConfig 方法）。
 * 可读性描述（toString 方法）。
 *
 * 示例：
 * spring:
 *   cloud:
 *     gateway:
 *       routes:
 *         - id: example_route
 *           uri: http://example.org
 *           predicates:
 *             - Header=X-Request-Id, ^[0-9]+$
 * </p>
 */
public class HeaderRoutePredicateFactory extends AbstractRoutePredicateFactory<HeaderRoutePredicateFactory.Config> {

	/**
	 * Header key.
	 */
	public static final String HEADER_KEY = "header";

	/**
	 * Regexp key.
	 */
	public static final String REGEXP_KEY = "regexp";

	public HeaderRoutePredicateFactory() {
		super(Config.class);
	}

	@Override
	public List<String> shortcutFieldOrder() {
		return Arrays.asList(HEADER_KEY, REGEXP_KEY);
	}

	@Override
	public Predicate<ServerWebExchange> apply(Config config) {
		Pattern pattern = (StringUtils.hasText(config.regexp)) ? Pattern.compile(config.regexp) : null;

		return new GatewayPredicate() {
			@Override
			public boolean test(ServerWebExchange exchange) {
				List<String> values = exchange.getRequest()
					.getHeaders()
					.getOrDefault(config.header, Collections.emptyList());
				if (values.isEmpty()) {
					return false;
				}
				// values is now guaranteed to not be empty
				if (pattern != null) {
					// check if a header value matches
					for (int i = 0; i < values.size(); i++) {
						String value = values.get(i);
						if (pattern.asMatchPredicate().test(value)) {
							return true;
						}
					}
					return false;
				}

				// there is a value and since regexp is empty, we only check existence.
				return true;
			}

			@Override
			public Object getConfig() {
				return config;
			}

			@Override
			public String toString() {
				return String.format("Header: %s regexp=%s", config.header, config.regexp);
			}
		};
	}

	@Validated
	public static class Config {

		@NotEmpty
		private String header;

		private String regexp;

		public String getHeader() {
			return header;
		}

		public Config setHeader(String header) {
			this.header = header;
			return this;
		}

		public String getRegexp() {
			return regexp;
		}

		public Config setRegexp(String regexp) {
			this.regexp = regexp;
			return this;
		}

	}

}
